<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Page</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Page</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A class to define a Page object with common headers and footers.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Aaron Ryden &lt;<a href="mailto:aryden@gmail.com">aryden@gmail.com</a>&gt;</li>
				<li><span class="field">author:</span> Kevin Fodness &lt;<a href="mailto:kevin.fodness@gmail.com">kevin.fodness@gmail.com</a>&gt;</li>
				<li><span class="field">author:</span> Mike Pennisi &lt;<a href="mailto:mpennisi@andrew.cmu.edu">mpennisi@andrew.cmu.edu</a>&gt;</li>
				<li><span class="field">link:</span> <a href="http://code.google.com/p/buylocalopensourcerensselaer/">http://code.google.com/p/buylocalopensourcerensselaer/</a></li>
				<li><span class="field">license:</span> <a href="http://opensource.org/licenses/gpl-license.php">GNU Public License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---classes---class_Page.php.html">/src/classes/class_Page.php</a> (line <span class="field">31</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageAdminUsers.html">PageAdminUsers</a></td>
					<td>
											A class to display /admin/users.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageHome.html">PageHome</a></td>
					<td>
											A class to display /index.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageNewEvent.html">PageNewEvent</a></td>
					<td>
											A class to display /user/create_event.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageOwnerEvents.html">PageOwnerEvents</a></td>
					<td>
											A class to display /owner/events.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageOwnerStores.html">PageOwnerStores</a></td>
					<td>
											A class to display /owner/events.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageEvent.html">PageEvent</a></td>
					<td>
											A class to display /event.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageStores.html">PageStores</a></td>
					<td>
											A class to display /stores.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageUserProfile.html">PageUserProfile</a></td>
					<td>
											A class to display /user/profile.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageNewStore.html">PageNewStore</a></td>
					<td>
											A class to display /user/create_store.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageAdminCategories.html">PageAdminCategories</a></td>
					<td>
											A class to display /admin/categories.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageEvents.html">PageEvents</a></td>
					<td>
											A class to display /events.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageAdminEvents.html">PageAdminEvents</a></td>
					<td>
											A class to display /admin/events.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageEditevent.html">PageEditevent</a></td>
					<td>
											A class to display /user/edit_event.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageInfo.html">PageInfo</a></td>
					<td>
											A class to display pages under /info/
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageBrowse.html">PageBrowse</a></td>
					<td>
											A class to display /browse.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageSearch.html">PageSearch</a></td>
					<td>
											A class to display /search.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageRegister.html">PageRegister</a></td>
					<td>
											A class to display /register.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageAdminStores.html">PageAdminStores</a></td>
					<td>
											A class to display /admin/stores.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageLogin.html">PageLogin</a></td>
					<td>
											A class to display /login.php.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../BuyLocal/PageEditStore.html">PageEditStore</a></td>
					<td>
											A class to display /user/edit_store.php.
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																<div class="var-title">
					<span class="var-type">object</span>
					<a href="#$db" title="details" class="var-name">$db</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$keywords" title="details" class="var-name">$keywords</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$radius" title="details" class="var-name">$radius</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$subtitle" title="details" class="var-name">$subtitle</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$title" title="details" class="var-name">$title</a>
				</div>
																<div class="var-title">
					<span class="var-type">object</span>
					<a href="#$user" title="details" class="var-name">$user</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																				
												<div class="method-definition">
											<span class="method-result">Page</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#printFooter" title="details" class="method-name">printFooter</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#printHeader" title="details" class="method-name">printHeader</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#setTitle" title="details" class="method-name">setTitle</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$db" id="$db"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">object</span>
			<span class="var-name">$db</span>
						(line <span class="line-number">79</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database access object.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$keywords" id="$keywords"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$keywords</span>
						(line <span class="line-number">55</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Variable to contain the keywords for this page.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$radius" id="$radius"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$radius</span>
						(line <span class="line-number">71</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Array to contain the search radius values.</p>
	<ul class="tags">
				<li><span class="field">var:</span> Comes from constant SEARCH_RADIUS defined in presets.php</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$subtitle" id="$subtitle"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$subtitle</span>
						(line <span class="line-number">47</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Variable to contain the page's subtitle.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$title" id="$title"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$title</span>
						(line <span class="line-number">39</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Variable to contain the page's title.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$user" id="$user"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">object</span>
			<span class="var-name">$user</span>
						(line <span class="line-number">63</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Object to contain information about the user.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">85</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor function.  Establishes a database connection, sets $user  and $radius.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Page</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../BuyLocal/PageAdminUsers.html#method__construct">PageAdminUsers::__construct()</a>
								: Constructor function.  Calls the parent constructor, sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageHome.html#method__construct">PageHome::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageNewEvent.html#method__construct">PageNewEvent::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageOwnerEvents.html#method__construct">PageOwnerEvents::__construct()</a>
								: Constructor function.  Calls the parent constructor, sets the title,
							</li>
					<li>
				<a href="../BuyLocal/PageOwnerStores.html#method__construct">PageOwnerStores::__construct()</a>
								: Constructor function.  Calls the parent constructor, sets the title,
							</li>
					<li>
				<a href="../BuyLocal/PageEvent.html#method__construct">PageEvent::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageStores.html#method__construct">PageStores::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageUserProfile.html#method__construct">PageUserProfile::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageNewStore.html#method__construct">PageNewStore::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageAdminCategories.html#method__construct">PageAdminCategories::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageEvents.html#method__construct">PageEvents::__construct()</a>
								: Constructor function.  Calls the parent constructor, sets the title,  and sets session variables.
							</li>
					<li>
				<a href="../BuyLocal/PageAdminEvents.html#method__construct">PageAdminEvents::__construct()</a>
								: Constructor function.  Calls the parent constructor, sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageEditevent.html#method__construct">PageEditevent::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageInfo.html#method__construct">PageInfo::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageBrowse.html#method__construct">PageBrowse::__construct()</a>
								: Constructor function.  Calls the parent constructor, sets the title,  and sets session variables.
							</li>
					<li>
				<a href="../BuyLocal/PageSearch.html#method__construct">PageSearch::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageRegister.html#method__construct">PageRegister::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageAdminStores.html#method__construct">PageAdminStores::__construct()</a>
								: Constructor function.  Calls the parent constructor, sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageLogin.html#method__construct">PageLogin::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
					<li>
				<a href="../BuyLocal/PageEditStore.html#method__construct">PageEditStore::__construct()</a>
								: Constructor function.  Calls the parent constructor and sets the title.
							</li>
				</ul>
	</div>
<a name="methodprintFooter" id="printFooter"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">printFooter</span> (line <span class="line-number">375</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function for printing the footer.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			printFooter
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodprintHeader" id="printHeader"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">printHeader</span> (line <span class="line-number">115</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function to print the page header.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			printHeader
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetTitle" id="setTitle"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setTitle</span> (line <span class="line-number">104</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function to set the page title.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			setTitle
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$title</span><span class="var-description">: The pagetitle to set.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 19 Dec 2009 19:45:16 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>